1、swagger2 注解整体说明

用于controller类上：

用于方法上面（说明参数的含义）：

用于方法上面（返回参数或对象的说明）：

对象类：

2、@Api：请求类的说明

1
@Api：放在 请求的类上，与 @Controller 并列，说明类的作用，如用户模块，订单类等。
2
    tags="说明该类的作用"
3
    value="该参数没什么意义，所以不需要配置"

示例：

1
@Api(tags="订单模块")
2
@Controller
3
public class OrderController {
4
 
5
}

@Api 其它属性配置：

3、@ApiOperation：方法的说明

1
@ApiOperation："用在请求的方法上，说明方法的作用"
2
    value="说明方法的作用"
3
    notes="方法的备注说明"

3.1、@ApiImplicitParams、@ApiImplicitParam：方法参数的说明

1
@ApiImplicitParams：用在请求的方法上，包含一组参数说明
2
    @ApiImplicitParam：对单个参数的说明
3
        name：参数名
4
        value：参数的汉字说明、解释
5
        required：参数是否必须传
6
        paramType：参数放在哪个地方
7
            · header --> 请求参数的获取：@RequestHeader
8
            · query --> 请求参数的获取：@RequestParam
9
            · path（用于restful接口）--> 请求参数的获取：@PathVariable
10
            · body（请求体）-->  @RequestBody User user
11
            · form（普通表单提交）
12
        dataType：参数类型，默认String，其它值dataType="Integer"
13
        defaultValue：参数的默认值

示列：

1
@Api(tags="用户模块")
2
@Controller
3
public class UserController {
4
 
5
    @ApiOperation(value="用户登录",notes="随边说点啥")
6
    @ApiImplicitParams({
7
        @ApiImplicitParam(name="mobile",value="手机号",required=true,paramType="form"),
8
        @ApiImplicitParam(name="password",value="密码",required=true,paramType="form"),
9
        @ApiImplicitParam(name="age",value="年龄",required=true,paramType="form",dataType="Integer")
10
    })
11
    @PostMapping("/login")
12
    public JsonResult login(@RequestParam String mobile, @RequestParam String password,
13
    @RequestParam Integer age){
14
        //...
15
        return JsonResult.ok(map);
16
    }
17
}

4、@ApiResponses、@ApiResponse：方法返回值的说明

1
@ApiResponses：方法返回对象的说明
2
    @ApiResponse：每个参数的说明
3
        code：数字，例如400
4
        message：信息，例如"请求参数没填好"
5
        response：抛出异常的类

示例：

1
@Api(tags="用户模块")
2
@Controller
3
public class UserController {
4
 
5
    @ApiOperation("获取用户信息")
6
    @ApiImplicitParams({
7
        @ApiImplicitParam(paramType="query", name="userId", dataType="String", required=true, value="用户Id")
8
    }) 
9
    @ApiResponses({
10
        @ApiResponse(code = 400, message = "请求参数没填好"),
11
        @ApiResponse(code = 404, message = "请求路径没有或页面跳转路径不对")
12
    }) 
13
    @ResponseBody
14
    @RequestMapping("/list")
15
    public JsonResult list(@RequestParam String userId) {
16
        ...
17
        return JsonResult.ok().put("page", pageUtil);
18
    }
19
}

5、@ApiModel：用于JavaBean上面，表示一个JavaBean（如：响应数据）的信息

1
@ApiModel：用于JavaBean的类上面，表示此 JavaBean 整体的信息
2
            （这种一般用在post创建的时候，使用 @RequestBody 这样的场景，
3
            请求参数无法使用 @ApiImplicitParam 注解进行描述的时候 ）

5.1、@ApiModelProperty：用在JavaBean类的属性上面，说明属性的含义

示例:

1
@ApiModel(description= "返回响应数据")
2
public class RestMessage implements Serializable{
3
 
4
    @ApiModelProperty(value = "是否成功")
5
    private boolean success=true;
6
    @ApiModelProperty(value = "返回对象")
7
    private Object data;
8
    @ApiModelProperty(value = "错误编号")
9
    private Integer errCode;
10
    @ApiModelProperty(value = "错误信息")
11
    private String message;
12
 
13
    / getter/setter 略/
14
}

http://localhost:5680/zxmall/swagger-ui.html</a></p>